Appearance
Stored only in your browser. Get one under Tokens.
Send a command to a device connected over MQTT
POST
/devices/{id}/commands
Queues one of the allowlisted commands (REBOOT_DEVICE, RUN_GC,
ENABLE_SSH, DISABLE_SSH, LIST_CONTAINERS, LIST_GROUPS, LIST_DAEMONS,
LIST_DRIVERS, LIST_WAKELOCKS, GET_XCONNECT_GRAPH, LIST_LOG_SOURCES) for delivery over MQTT.
REBOOT_DEVICE accepts an optional string args.message, LIST_LOG_SOURCES an optional
args.rev (default "current"); other arguments are ignored.
Only the device owner may send commands, and only while the device is connected over MQTT.
Requires the full API scope or devices.commands. At most 10 commands per device per minute, and 1 REBOOT_DEVICE.
Authorizations
ApiKeyAuth
Type
API Key (header: Authorization)
Parameters
Path Parameters
id*
ID|PRN|NICK
Type
Requiredstring
Request Body
application/json
JSON "args": { "additionalProperties": "string" }, "cmd": "string"
{
}
Responses
Created
application/json
JSON "args": { "additionalProperties": "string" }, "cmd": "string", "code": 0, "created_at": "string", "created_by": "string", "device_id": "string", "error": "string", "expires_at": "string", "finished_at": "string", "id": "string", "output": { }, "status": "string"
{
}